POV-Ray : Newsgroups : povray.documentation.inbuilt : The docs stink. : The docs stink. Server Time
15 May 2024 13:08:41 EDT (-0400)
  The docs stink.  
From: Tom Melly
Date: 5 Feb 2002 06:29:58
Message: <3c5fc236@news.povray.org>
No, really. They smell of limburgh.

Actually, I do have some serious comments (3.5 docs specifically, but iirc most
of these comments can be applied to 3.1 docs).

The indexing and searching can be a little counter-intuitive. For example:

Look for cylinder in the index, and "cylinder object" is returned as the second
choice. However, look for sphere, and no "sphere object" is listed. It would be
nice to be able to quickly know which listing, when multiple listings are
returned, will take you to the basic syntax for a feature (e.g. "cylinder
syntax", although "cylinder object" seems fine if it was used consistently)

Also, if you search for cylinder, "cylinder object" (the cylinder syntax) is
ranked 15, with the rather unhelpful finite solid primitives (6.5.1) returned as
rank 1. IMHO when searching for keywords, it would be better if the syntax was
always returned as rank 1.

2. I sometimes wonder if the docs would be better split into two seperate help
files - a syntax and include file help and a tutorial help. I dunno, just an
idea. I'm probably being a bit lame, but, when I need to quickly check the
syntax of an object/feature, it sometimes takes me a couple of goes, and a shift
in concentration, before I can find it in the docs.

This would also allow the tutorial help to be updated with new tutorials etc.
without having to muck around with the unchanging SDL docs.

Just my two aromas worth....
--
#macro G(D,E,F)#local I=array[3]{D,E,F}#local B=0;triangle{#while(
B<3)#while(I[B])A[mod(I[B],10)]+#local I[B]=div(I[B],10);#end<-5,-
2,9>#local B=B+1;#end}#end #local A=array[7]{x,x*2,x*4,y,y*2,y*4,z
}light_source{-x*6-z*9,1}mesh{G(105,10,146)G(105,246,10)G(105,56,
146)G(105,1256,246)G(1256,126,220)G(22156,2216,201)pigment{rgb 1}}//TM


Post a reply to this message

Copyright 2003-2023 Persistence of Vision Raytracer Pty. Ltd.